home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / comm / mail / xsig11.lha / FileSpecs.txt < prev    next >
Text File  |  1994-06-26  |  3KB  |  103 lines
  1. --------------------------------------------------------------------------
  2. $VER: XSig_FILE 0.5 (26.06.94)
  3. --------------------------------------------------------------------------
  4.  
  5. XSig File Specifications
  6. ========================
  7. (C) Copyright 1994 by Jürgen Weinelt. Read "XSig.doc" for details.
  8. ------------------------------------------------------------------
  9.  
  10. (0) IMPORTANT WARNING!
  11. ----------------------
  12. DO NOT WRITE ANY TOOLS THAT DEPEND ON THE LAYOUT OF THE "INDEX" OR
  13. "POINTER" FILE. THE FILE LAYOUT OF THESE TWO FILES MAY CHANGE.
  14. YOU HAVE BEEN WARNED.
  15.  
  16.  
  17.  
  18. (1) The Main Configuration File
  19. -------------------------------
  20. XSig's main config file is called "uulib:XSig.data" and must have the
  21. following layout:
  22.  
  23. First line: "#H XSIG DATA"
  24. XSig needs this header to identify its config file.
  25.  
  26. Second line: "#B <base_directory_for_the_cookie_files>"
  27. This line tells XSig where to find its cookies and the related files.
  28.  
  29. Third...n-th line: "#G <group_pattern> <mode> <fixed> <var_basename>"
  30. This line tells XSig what signature to use.
  31.  
  32. The fields of the "#G"-line are:
  33.  
  34.    <group_pattern>      any valid AmigaDOS-pattern (no whitespace allowed)
  35.    <mode>               "S": cycle through the cookies sequentially
  36.                         "R": pick one cookie randomly
  37.    <fixed>              fixed signature text
  38.    <var_basename>       cookie file (basename)
  39.  
  40. You are allowed to add comment lines anywhere in the main configuration
  41. file. A comment line starts with "#R" and is ignored completely.
  42.  
  43. XSig expects the following files:
  44.        <fixed>              fixed signature text, e.g. your eMail address
  45.                             (plain ASCII, no special layout)
  46.                             Typically this will be your ".signature" file.
  47.  
  48.    <var_basename>.cookie    cookie data file, layout see below
  49.    <var_basename>.index     cookie index file, layout see below
  50.    <var_basename>.pointer   cookie pointer file, layout see below
  51.  
  52. XSig.data example:
  53.  
  54. - snip - snip - snip - snip - snip - snip - snip - snip -
  55. #H XSIG DATA
  56. #B uulib:XSig/
  57. #G comp.#?  S   comp-sig-fixed  comp-sig-cookies
  58. #G alt.#?   R   alt-sig-fixed   alt-sig-cookies
  59. #G #?       S   comp-sig-fixed  default-sig-cookies
  60. - snip - snip - snip - snip - snip - snip - snip - snip -
  61.  
  62.  
  63.  
  64. (2) The Cookie Data File
  65. ------------------------
  66. First line: "#H XSIG COOKIE"
  67. XSig needs this header to identify its cookie data file.
  68.  
  69. The rest of the file contains cookies (plain ASCII text); the cookies are
  70. separated by "#--" (must be on a separate line, and there must be at least
  71. two [or more] dashes!).
  72.  
  73.  
  74.  
  75. (3) The Cookie Index File
  76. -------------------------
  77. First line: "#H XSIG INDEX"
  78. XSig needs this header to identify its index data file.
  79.  
  80. Second line: "#C <count>"
  81. Tells XSig the number of index pairs in the index file.
  82.  
  83. Second...n-th line: "#I <pos> <size>"
  84. These "#I"-lines tell XSig where the cookies in the main cookie data file
  85. start and how long they are.
  86.  
  87. Note: You should NEVER edit the cookie index file manually. After any
  88. change in the cookie data file, just run "XSigIDX <var_basename>" to
  89. rebuild the index.
  90.  
  91.  
  92.  
  93. (4) The Cookie Pointer File
  94. ---------------------------
  95. First line: "#H XSIG POINTER"
  96. XSig needs this header to identify its pointer data file.
  97.  
  98. Second line: "#P <num>"
  99. This tells XSig which cookie to pick next.
  100.  
  101. Note: You should NEVER edit the cookie pointer file manually. To reset the
  102. pointer file, just rebuild the cookie index file (see (3)).
  103.